<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: HPPASS       (High Performance Programmable Analog Sub-System)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__hppass.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">API Reference</a>  </div>
  <div class="headertitle">
<div class="title">HPPASS (High Performance Programmable Analog Sub-System)</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The High Performance Programmable Analog Sub-System (HPPASS) PDL driver provides API to use the High Performance Programmable Analog Sub-System (HPPASS) HW block. </p>
<h1><a class="anchor" id="group_hppass_glossary"></a>
Glossary</h1>
<ul>
<li>AC - Autonomous Controller, state machine engine for High Performance Programmable Analog Sub-System</li>
<li>TC - Timer/Counter, the sub-block of the AC</li>
<li>STT - State Transition Table, the table of state machine states for High Performance Programmable Analog Sub-System, essentially the 'program' for AC.</li>
<li>CSG - Comparator Slope Generator</li>
</ul>
<h1><a class="anchor" id="group_hppass_configuration"></a>
Configuration Considerations</h1>
<p>In order to start the HPPASS, following functions should be called in order:</p><ul>
<li><a class="el" href="group__group__hppass__cfg__functions.html#ga8d22889d8dd8c3fd87df1db2869a6956">Cy_HPPASS_Init</a> - initializes entire HPPASS block registers, including STT, SAR and CSG. Refer to config struct <a class="el" href="structcy__stc__hppass__cfg__t.html">cy_stc_hppass_cfg_t</a> for details.</li>
<li><a class="el" href="group__group__hppass__ac__functions.html#gabbf381cbbe92e087faf4c89a549cd1d7">Cy_HPPASS_AC_Start</a> - starts the AC, which starts the HPPASS block operation. Refer to <a class="el" href="group__group__hppass__ac.html">AC (Autonomous Controller)</a> for details.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>When using the HPPASS personality in the Device Configurator, the personality includes "Initialize During Startup" checkbox (enabled by default). When enabled, the <a class="el" href="group__group__hppass__cfg__functions.html#ga8d22889d8dd8c3fd87df1db2869a6956">Cy_HPPASS_Init</a> function will be called inside of the init_cycfg_all() function.</dd></dl>
<h1><a class="anchor" id="group_hppass_more_information"></a>
More Information</h1>
<p>For more information on the HPPASS peripheral, refer to the technical reference manual (TRM).</p>
<h1><a class="anchor" id="group_hppass_changelog"></a>
Changelog</h1>
<table class="doxtable">
<tr>
<th>Version</th><th>Changes</th><th>Reason for Change </th></tr>
<tr>
<td rowspan="2">1.30 </td><td>Added <a class="el" href="group__group__hppass__sar__functions.html#gae7372202646043f2295c6b1367424216">Cy_HPPASS_SAR_CrossTalkAdjust</a> function. </td><td>Driver enhancement.  </td></tr>
<tr>
<td>Documentation update. </td><td>Documentation enhancement.  </td></tr>
<tr>
<td rowspan="3">1.20 </td><td>Updated <a class="el" href="group__group__hppass__sar__functions.html#ga1ac70409790506a22b8ae995c272a435">Cy_HPPASS_SAR_SetTempSensorCurrent</a> function interface. </td><td>Usability improvement.  </td></tr>
<tr>
<td>Updated <a class="el" href="group__group__hppass__sar__functions.html#gaf2058860b27001f3d1eb23ad5f086e6c">Cy_HPPASS_TEMP_Calc</a> function input parameters range check. </td><td>Defect fixing.  </td></tr>
<tr>
<td>Documentation update. </td><td>Documentation enhancement.  </td></tr>
<tr>
<td rowspan="4">1.10 </td><td>Added personality DRCs. </td><td>Defect fixing.  </td></tr>
<tr>
<td>Fixed offset calculation for Cy_HPPASS_SAR_CountsTo_Volts function. </td><td>Defect fixing.  </td></tr>
<tr>
<td>Added <a class="el" href="group__group__hppass__rt__functions.html#ga43d9123b2df71179051481e35cc19ad5">Cy_HPPASS_SetFwTriggerPulse</a>, <a class="el" href="group__group__hppass__rt__functions.html#ga77fb946fbb6b3a39a7d6b40cfca4bfdd">Cy_HPPASS_SetFwTriggerLevel</a>, and <a class="el" href="group__group__hppass__rt__functions.html#ga7985980ea054aeffd4a80eaecae32bb7">Cy_HPPASS_ClearFwTriggerLevel</a> functions. </td><td>Driver enhancement.  </td></tr>
<tr>
<td>Documentation update. </td><td>Documentation enhancement.  </td></tr>
<tr>
<td rowspan="1">1.0 </td><td>Initial version. </td><td></td></tr>
</table>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
API Reference</h2></td></tr>
<tr class="memitem:group__group__hppass__common"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__common.html">Common</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hppass__ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__ac.html">AC (Autonomous Controller)</a></td></tr>
<tr class="memdesc:group__group__hppass__ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">This driver provides API functions to configure, manage and interact with the Autonomous Controller (AC) subsystem within High Performance Programmable Analog Sub-System (HPPASS). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hppass__csg"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__csg.html">CSG (Comparator Slope Generator)</a></td></tr>
<tr class="memdesc:group__group__hppass__csg"><td class="mdescLeft">&#160;</td><td class="mdescRight">This driver provides API functions to configure the Comparator Slope Generator within High Power Programmable Analog Sub-System. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hppass__sar"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar.html">SAR (Successive-Approximation Register Analogue to Digital Converter)</a></td></tr>
<tr class="memdesc:group__group__hppass__sar"><td class="mdescLeft">&#160;</td><td class="mdescRight">This driver provides API functions to configure the SAR ADC subsystem within High Power Programmable Analog Sub-System. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
